Skip to main content
POST
/
hris
/
employees
[DEPRECATED] Create employee
curl --request POST \
  --url https://api.kombo.dev/v1/hris/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "first_name": "John",
  "last_name": "Doe",
  "work_email": "john.doe@acme.com",
  "gender": "MALE",
  "date_of_birth": "1986-01-01",
  "start_date": "2020-04-07",
  "job_title": "Integrations Team Lead",
  "home_address": {
    "city": "Berlin",
    "country": "DE",
    "state": "Berlin",
    "street_1": "Sonnenallee 63",
    "zip_code": "12045"
  }
}'
{
  "status": "success",
  "data": {
    "id": "26vafvWSRmbhNcxJYqjCzuJg",
    "remote_id": "32",
    "employee_number": "3243422",
    "first_name": "John",
    "last_name": "Doe",
    "nationality": "French",
    "display_full_name": "John Doe",
    "job_title": "Integrations Team Lead",
    "work_email": "john.doe@acme.com",
    "personal_email": "john@doe.me",
    "mobile_phone_number": "801-555-4687",
    "ssn": "555-32-6395",
    "tax_id": "12 345 678 901",
    "gender": "MALE",
    "ethnicity": "BLACK_AFRICAN_AMERICAN",
    "marital_status": "MARRIED",
    "employment_status": "INACTIVE",
    "employment_type": "FULL_TIME",
    "weekly_hours": 40,
    "avatar": "https://resources.bamboohr.com/images/photo_person_150x150.png",
    "work_location_id": "7E2gyuv6TmvtByzBxW9Sxt53",
    "legal_entity_id": "xB32bied320csBSsl3XWdlw33",
    "manager_id": "9pf2pxBB8VX8EQMC9aipW2Bo",
    "home_address": {
      "city": "Berlin",
      "country": "DE",
      "raw": "Sonnenallee 63\n12045 Berlin\nGermany",
      "state": "Berlin",
      "street_1": "Sonnenallee 63",
      "street_2": null,
      "zip_code": "12045"
    },
    "bank_accounts": [
      {
        "account_number": "1234567890",
        "bank_name": "Commerzbank",
        "bic": "COBADEFFXXX",
        "domestic_bank_routing": {
          "number": "34567890",
          "type": "DE_BANKLEITZAHL"
        },
        "holder_name": "John Doe",
        "iban": "DE12345678901234567890"
      }
    ],
    "date_of_birth": "1986-01-01T00:00:00.000Z",
    "start_date": "2020-04-07T00:00:00.000Z",
    "termination_date": "2022-05-20T00:00:00.000Z",
    "remote_created_at": "2020-04-07T12:32:01.000Z",
    "changed_at": "2022-08-07T14:01:29.196Z",
    "remote_deleted_at": null,
    "custom_fields": {},
    "integration_fields": [],
    "remote_data": null
  },
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Body

application/json

POST /hris/employees Request body

​
first_name
string
required

The first name of the employee.

​
last_name
string
required

The last name of the employee.

​
work_email
string<email>

The email address of the employee to be created. For tools where the personal email address is required, we map this input to the personal email. This is documented on a per-tool basis.

​
gender
enum<string>

The gender of the employee.

Available options:
MALE,
FEMALE,
NON_BINARY,
NOT_SPECIFIED
​
job_title
string

The title of the position this person is working in.

​
home_address
object

The employee's home address.

​
date_of_birth
string<date-time>

The employee's date of birth. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.

​
mobile_phone_number
string
​
home_phone_number
string
​
nationality
string

The uppercase two-letter ISO country (e.g., DE). For systems that use codes in formats other than ISO 3166-1 alpha-2, Kombo transforms the ISO Codes to the appropriate value.

​
start_date
string<date-time>

Start date of the employee. Also considered to be the hire date. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.

​
legal_entity_id
string

The Kombo ID of the legal entity the employee should be in. This field is required for certain integrations.

​
location_id
string

The Kombo ID of the location the employee should be in. This field is required for certain integrations.

​
remote_fields
object

Additional fields that we will pass through to specific HRIS systems.

Response

POST /hris/employees Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples:
{
  "id": "26vafvWSRmbhNcxJYqjCzuJg",
  "remote_id": "32",
  "employee_number": "3243422",
  "first_name": "John",
  "last_name": "Doe",
  "nationality": "French",
  "display_full_name": "John Doe",
  "job_title": "Integrations Team Lead",
  "work_email": "john.doe@acme.com",
  "personal_email": "john@doe.me",
  "mobile_phone_number": "801-555-4687",
  "ssn": "555-32-6395",
  "tax_id": "12 345 678 901",
  "gender": "MALE",
  "ethnicity": "BLACK_AFRICAN_AMERICAN",
  "marital_status": "MARRIED",
  "employment_status": "INACTIVE",
  "employment_type": "FULL_TIME",
  "weekly_hours": 40,
  "avatar": "https://resources.bamboohr.com/images/photo_person_150x150.png",
  "work_location_id": "7E2gyuv6TmvtByzBxW9Sxt53",
  "legal_entity_id": "xB32bied320csBSsl3XWdlw33",
  "manager_id": "9pf2pxBB8VX8EQMC9aipW2Bo",
  "home_address": {
    "city": "Berlin",
    "country": "DE",
    "raw": "Sonnenallee 63\n12045 Berlin\nGermany",
    "state": "Berlin",
    "street_1": "Sonnenallee 63",
    "street_2": null,
    "zip_code": "12045"
  },
  "bank_accounts": [
    {
      "account_number": "1234567890",
      "bank_name": "Commerzbank",
      "bic": "COBADEFFXXX",
      "domestic_bank_routing": {
        "number": "34567890",
        "type": "DE_BANKLEITZAHL"
      },
      "holder_name": "John Doe",
      "iban": "DE12345678901234567890"
    }
  ],
  "date_of_birth": "1986-01-01T00:00:00.000Z",
  "start_date": "2020-04-07T00:00:00.000Z",
  "termination_date": "2022-05-20T00:00:00.000Z",
  "remote_created_at": "2020-04-07T12:32:01.000Z",
  "changed_at": "2022-08-07T14:01:29.196Z",
  "remote_deleted_at": null,
  "custom_fields": {},
  "integration_fields": [],
  "remote_data": null
}
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.